Skip to content

Strip release-process narration from per-repo docs - #3

Merged
thedavidmeister merged 1 commit into
mainfrom
2026-08-20-strip-release-docs
Aug 20, 2026
Merged

Strip release-process narration from per-repo docs#3
thedavidmeister merged 1 commit into
mainfrom
2026-08-20-strip-release-docs

Conversation

@thedavidmeister

@thedavidmeister thedavidmeister commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Docs-only. Strip release-process narration that this per-repo doc restates but does not own.

Human ruling (2026-08-20): "you really shouldn't put release processes in the per repo docs because it's super fragile." The release process is owned by rainix's rainix-tag-release.yaml reusable; per-repo restatements drift the moment the reusable changes — which just happened: rainlanguage/rainix#338 / rainlanguage/rainix#339 made tag-release push-free, so this repo's "commits the frozen record back to main" was already factually wrong.

Removed

  • .github/workflows/package-release.yaml — collapsed the header comment (why-not-autopublish rationale + rainix-tag-release's chain-verification gate) to one line of deploy-repo identity.
  • CLAUDE.md "Deployment and releases" — removed the rainix-tag-release mechanics (cuts the frozen src/generated/<tag>/ record via cutRelease and publishes rain-extrospection-deploy to Soldeer).
  • README.md "Releases" — removed the full rainix-tag-release mechanics paragraph (regenerate candidate / freeze / regenerate released-suites libs / verify chains / publish to Soldeer / commit record back to main — now stale).

Kept (repo-local invariants an agent would get wrong from the repo alone)

Deploy address is a pure function of the bytecode (Zoltu); the deploy is a manual dispatch run BEFORE the tag; releases are manual sol-v* tags not merges; releasedSuites() is empty until the first release is cut; the deploy-record section's frozen src/generated/<tag>/ facts are untouched.

QA

Summary by CodeRabbit

  • Documentation
    • Updated release guidance to reflect the manual sol-v* tagging process.
    • Clarified that release mechanics are maintained externally and tags do not broadcast deployments.
    • Simplified workflow documentation while preserving the existing release behavior.

The release process is owned by rainix's rainix-tag-release reusable and
restating it per-repo drifts: rainlanguage/rainix#338 made tag-release
push-free, so the 'commits the snapshot back to main' narration here was
already stale. Docs-only; repo-local invariants kept, mechanics point to
rainix.

Ruling: rainlanguage/claude-audit-skills#91
Philosophy: rainlanguage/rainix#298

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@thedavidmeister thedavidmeister self-assigned this Aug 20, 2026
@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 6492d679-709d-49ad-a502-dbd5b40c08a4

📥 Commits

Reviewing files that changed from the base of the PR and between d49e834 and e1e75ab.

📒 Files selected for processing (3)
  • .github/workflows/package-release.yaml
  • CLAUDE.md
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

The release workflow comment and project documentation now describe manual sol-v* releases through rainix-tag-release. Workflow logic and configuration remain unchanged.

Changes

Manual release flow documentation

Layer / File(s) Summary
Manual release flow description
.github/workflows/package-release.yaml, CLAUDE.md, README.md
The comment and release guidance now describe manual sol-v* tags through rainix-tag-release. Obsolete automated publication and snapshot steps were removed.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to e1e75

This PR only removes stale release-process narration from repository documentation while preserving repository-local deployment facts; no actionable merge-blocking risk remains.

Possibly related issues

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the PR's main change: removing release-process details from repository-local documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-08-20-strip-release-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@thedavidmeister
thedavidmeister merged commit 247b6a8 into main Aug 20, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant